/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api;

import java.util.List;
import javax.xml.bind.annotation.XmlAttribute;

/**
 *
 * @author Fabien Barbero
 */
public abstract class Paginated<T> {
    
    @XmlAttribute(name="page")
    private int page;
    
    @XmlAttribute(name="pages")
    private int pages;
    
    @XmlAttribute(name="perpage")
    private int perpage;
    
    @XmlAttribute(name="total")
    private int total;

    
    /**
     * Get the current page.
     * @return The index of the page.
     */
    public final int getPageIndex() {
        return page;
    }

    /**
     * Get the number of pages.
     * @return The number of pages.
     */
    public final int getPagesCount() {
        return pages;
    }

    /**
     * Get the number of objects per page.
     * @return The number of objects per page.
     */
    public final int getPerPage() {
        return perpage;
    }

    /**
     * Get the total number of available objects.
     * @return The number of objects.
     */
    public final int getTotalCount() {
        return total;
    }
    
    /**
     * Get the paginted values.
     * @return The values.
     */
    public abstract List<T> getValues();
    
}
